Importing Users using the Admin Console

If you have lots of users that you want to grant access to Pyramid, you can use the Import User process to create a CSV file of users and then pull them into Pyramid in one bulk action. This saves time and effort. It is particularly useful where you are setting up a new team or new system.

There are two techniques for accelerated addition of users into Pyramid:

  1. Provisioning, where you can auto sync the Pyramid user list with groups from the authentication provider. Provisioning is only available for Active Directory, Azure Active Directory, Open LDAP, or SAML or OpenID where Provider Provisioning Settings are configured.
  2. Bulk import (this process), where you can upload a list of users and their details using a static CSV formatted file.

Note: Roles can also be uploaded into the system in Bulk.

Importing users

Before you begin

  • You must have already set up your Authentication Provider with at least one initial user.
  • You can repeat this process any time you want to load a Bulk Set of users.

Creating your Upload File

The CSV file that you use to import users in Bulk has different columns depending on the target Authentication Provider and whether you have supplied Provider Provisioning Settings to allow Pyramid to search for user details held by your Authentication Provider.

You can download an empty spreadsheet (*.csv) for your own bulk loading process:

For details of the fields that you need to complete for each of these file types, see below.

Important: The first row in the CSV file is always treated as a header row. Your spreadsheet must include all columns described below. Where a column is described as "optional," the column may be left empty but still needs to be present in the spreadsheet.

Uploading your file

Once your CSV file is ready, you should save it and then upload it into Pyramid.

You can add users using the Admin Console:

  1. In the left-hand menu, select Access > Users.

    2. The Users page opens, showing the current User List in the main body of the page.

  2. From the buttons at the top-right of the page, select the "add" option you require:

To add users in bulk, click Import (green arrow above) to open the Import Users dialog. Navigate to and select your CSV file.

Tip: If you actually want to add a single user, click New User (purple arrow) and select <User Type> from the drop-down. The details describing how to add a user following these steps are seen in Adding or Editing Users Manually and Adding Users through Search.

Upload File Formats

Active Directory Users

The active directory file needs to be in comma delimited format (CSV) where each row represents a user in the Active Directory that you want to load into Pyramid. The following columns are required:

  • domain\Username: The Active Directory account name in the format domain\username. The domain must be added to the system in the authentication settings in advance of this step.
  • License Type: The license type, 90 for Basic, 100 for Viewer, 150 for Analyst, and 200 for Professional. For more information about the license types, see Pyramid Licensing.
  • Admin Level: The admin level where the user has a professional license. 0 for no admin, 1 for domain admin, 2 for enterprise admin. For more information, see Admin Rights.
  • Tenant: The tenant name as it appears in the system. This is typically "default" if you have a single tenant setup.
  • Roles: The role name as it appears in the system. Multiple roles can be added using a semi-colon separator in this cell.
  • profile: The profile name as it appears in the system (optional). There can only be one profile per user. The profile must be compatible with the tenant and the license type. For more information, see Profiles.
  • proxy1:An alternative account name to be used with alternative system authentications. For example, the user's Active Directory account needed for Microsoft SSAS authentication, or the user's SAP BW login for onward connection in other single sign-on environments (for example, Azure or Snowflake). Optional.
  • proxy2: Another proxy account name.
  • language: The user's default application language. The LanguageType is defined as a number in Pyramid. For example, the value "2" in this column indicates that the user represented by the row has the application language French. For more information about the Language Type enumeration, see LanguageType.

DB, SAML, or Open ID Users (no search)

Where the Authentication Provider is one of Database (internal), SAML, or Open ID and Pyramid is not set up to search for user details on that Authentication Provider (Provider Provisioning Settings were not set up when configuring the Authentication Provider), the import file needs to include the following columns:

  • Username: The user's Pyramid username. The user ID for login ID's should contain only standard alpha numeric characters and no spaces.
  • License Type: The license type, 90 for Basic, 100 for Viewer, 150 for Analyst, and 200 for Professional. For more information about the license types, see Pyramid Licensing.
  • Admin Level: The admin level where the user has a professional license. 0 for no admin, 1 for domain admin, 2 for enterprise admin. For more information, see Admin Rights.
  • Tenant: The tenant name as it appears in the system. This is typically "default" if you have a single tenant setup.
  • Roles: The role name as it appears in the system. Multiple roles can be added using a semi-colon separator in this cell.
  • First Name: The first name for the user.
  • Last Name: The last name for the user.
  • Email: The email address for the user.
  • Password: The initial password for the user.
  • UPN: The Active Directory user name (optional, relevant when needing to connect to Active Directory-based data sources).
  • Profile: The profile name as it appears in the system (optional). There can only be one profile per user. The profile must be compatible with the tenant and the license type. For more information, see Profiles.
  • Proxy Account 1: An alternative account name to be used with alternative system authentications. For example, the user's Active Directory account needed for Microsoft SSAS authentication, or the user's SAP BW login for onward connection in other single sign-on environments (for example, Azure or Snowflake). Optional.
  • Proxy Account 2: Another proxy account name.
  • Language: The user's default application language. The LanguageType is defined as a number in Pyramid. For example, the value "2" in this column indicates that the user represented by the row has the application language French. For more information about the Language Type enumeration, see LanguageType.

SAML or Open ID Users (with search)

Where the Authentication Provider is one of SAML or Open ID and Pyramid is set up to search for user details on that Authentication Provider (Provider Provisioning Settings are set up for the Authentication Provider), the import file needs to include the following columns:

  • Search term: The username that should be used to search for the user in the Authentication provider.
  • License Type: The license type, 90 for Basic, 100 for Viewer, 150 for Analyst, and 200 for Professional. For more information about the license types, see Pyramid Licensing.
  • Admin Level: The admin level where the user has a professional license. 0 for no admin, 1 for domain admin, 2 for enterprise admin. For more information, see Admin Rights.
  • Tenant: The tenant name as it appears in the system. This is typically "default" if you have a single tenant setup.
  • Roles: The role name as it appears in the system. Multiple roles can be added using a semi-colon separator in this cell.
  • Password: The initial password for the user.
  • Profile: The profile name as it appears in the system (optional). There can only be one profile per user. The profile must be compatible with the tenant and the license type. For more information, see Profiles.
  • Proxy2: An alternative account name to be used with alternative system authentications. For example, the user's Active Directory account needed for Microsoft SSAS authentication, or the user's SAP BW login for onward connection in other single sign-on environments (for example, Azure or Snowflake). Optional.
  • language: The user's default application language. The LanguageType is defined as a number in Pyramid. For example, the value "2" in this column indicates that the user represented by the row has the application language French. For more information about the Language Type enumeration, see LanguageType.